package com.ideaaedi.zoo.diy.artifact.apidoc.knife4j.properties.nested;

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotBlank;
import lombok.Data;

/**
 * 文档鉴权能力
 */
@Data
public class SecurityScheme {
    
    @NotBlank(message = "当前鉴权策略的名称")
    @Schema(description = "当前鉴权策略的名称")
    private String schemeName = "defaultBearerAuth";
    
    @NotBlank(message = "请求头key不能为空")
    @Schema(description = "请求头 - key", example = "Authentication")
    private String headerKey;
    
    /**
     * @see io.swagger.v3.oas.models.security.SecurityScheme#getScheme()
     */
    @Schema(description = "安全方案的名称", example = "basic、bearer、digest...")
    private String scheme;
    
    /**
     * @see io.swagger.v3.oas.models.security.SecurityScheme#getBearerFormat()
     */
    @Schema(description = "当前权限的风格")
    private String bearerFormat;
    
}
